Configurable.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.commons.net.ftp;


/**
 * This interface adds the aspect of configurability by means of
 * a supplied FTPClientConfig object to other classes in the
 * system, especially listing parsers.
 */
public interface Configurable {

    /**
     * @param config the object containing the configuration data
     * @throws IllegalArgumentException if the elements of the 
     * <code>config</code> are somehow inadequate to configure the
     * Configurable object.
     */
    public void configure(FTPClientConfig config);
}